Skip to content

🪲 [Fix]: Correct the public command help and bring PSSemVer onto the current pipeline - #46

Merged
Marius Storhaug (MariusStorhaug) merged 7 commits into
mainfrom
align-with-psmodule-standards
Aug 2, 2026
Merged

🪲 [Fix]: Correct the public command help and bring PSSemVer onto the current pipeline#46
Marius Storhaug (MariusStorhaug) merged 7 commits into
mainfrom
align-with-psmodule-standards

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Aug 2, 2026

Copy link
Copy Markdown
Member

New-PSSemVer and ConvertTo-PSSemVer now carry correct, linkable help, and the repository runs the current Process-PSModule pipeline with the governance and documentation files the PSModule Repository Standard expects. The [PSSemVer] class and the exported commands behave exactly as before.

Fixed: Command help names real commands and links to the documentation

Both commands' examples referenced New-SemVer and ConvertTo-SemVer — commands this module does not export, so anyone copying Get-Help -Examples output got a CommandNotFoundException. Neither command had a .LINK, so Get-Help -Online had nowhere to go. Each now opens with its canonical psmodule.io documentation URL, followed by the SemVer specification.

This also unblocks CI: Process-PSModule v6 enforces PublicHelpLink, and Test-SourceCode failed on all three runners before the fix.

Changed: Process-PSModule refreshed to v6.1.15

The caller workflow was pinned to v5.4.6 and used secrets: inherit. v6.0.0 removed the fixed TEST_* secret inputs in favour of an explicit TestData object, so inheriting every repository secret is no longer needed. PSSemVer has no test secrets, so the caller now passes only APIKey, matching Template-PSModule and PSModule/GitHub.

Changed: Documentation site config moved to Zensical

Process-PSModule v6.1.13 made Build-Site Zensical-only, so .github/mkdocs.yml was dead configuration and the site was being built from framework defaults. It is replaced by the .github/zensical.toml that Template-PSModule ships.

New: Required governance and agent onboarding files

The repository now carries its own CONTRIBUTING.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, AGENTS.md, CLAUDE.md, and .github/pull_request_template.md instead of relying on the organization .github fallback, which agents, linters, and local tooling never read. The README already linked to CONTRIBUTING.md, which did not exist.

Changed: README follows the module start-page standard

Installation uses Install-PSResource instead of the deprecated Install-Module. The exhaustive per-method example list is replaced by a capabilities showcase covering parsing with a prefix and metadata, SemVer precedence, in-place bumping, and pipeline conversion — every snippet was executed against the module before being written down. The page links to the published documentation at psmodule.io/PSSemVer.

Technical Details

  • .github/workflows/Process-PSModule.yml: @205d193 # v5.4.6 -> @688896d # v6.1.15, secrets: inherit -> secrets: APIKey.
  • .github/mkdocs.yml deleted, .github/zensical.toml added.
  • .github/dependabot.yml: github-actions moved to a daily interval with a 7-day cooldown, matching the template default.
  • tests/PSSemVer.Tests.ps1 now declares #Requires -Modules @{ ModuleName = 'Pester'; ModuleVersion = '6.0.0'; MaximumVersion = '6.*' }, so a runner with Pester 5 available can no longer silently run the wrong version. A forced -Verbose write that only added log noise is gone.
  • Governance files are the Template-PSModule copies; AGENTS.md is adapted to describe PSSemVer and to flag that the public class shape is the module API.
  • .gitignore intentionally keeps !.vscode/*.code-snippets, which the template is missing relative to the canonical github/gitignore VS Code template — see 🪲 [Fix]: Keep VS Code snippet files out of the ignore list Template-PSModule#41.
  • Verified before pushing: 66/66 Pester 6 tests pass against a built artifact, and PSScriptAnalyzer is clean over src/ and tests/ with the repo linter settings.

Review findings filed separately

The behaviour review of [PSSemVer] found defects that change the public class contract, so they are not folded into this change.

Related issues

…xplicitly

Process-PSModule v6.0.0 removed the fixed TEST_* secret inputs. PSSemVer has no test secrets, so the caller now passes only APIKey instead of inheriting every repository secret.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Process-PSModule v6.1.13 made Build-Site Zensical-only, so the legacy .github/mkdocs.yml is no longer read. Replace it with the .github/zensical.toml that Template-PSModule ships.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
The Repository Standard requires every module repository to stand on its own instead of relying on the organization .github fallback. README already linked to CONTRIBUTING.md, which did not exist.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Switches the github-actions ecosystem to a daily interval with a 7-day cooldown, so the pinned Process-PSModule SHA is picked up promptly without churning on same-day releases.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

No Significant Changes Detected

This PR does not contain changes to files that would trigger a new release:

Pattern Description
^src/ Matches files where path matches this pattern
^README\.md$ Matches files where path matches this pattern

Build, test, and publish stages will be skipped for this PR.

If you believe this is incorrect, please verify that your changes are in the correct locations.

Switches the install snippet to Install-PSResource, replaces the exhaustive per-method example list with a short capabilities showcase, and links the published documentation site. Drops the community section that linked to a CONTRIBUTING.md the repository did not have.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
The framework runs the suite with Pester 6; the file did not declare it, so a runner with only Pester 5 available would silently run the wrong version. Also drops a forced -Verbose write that only added noise to CI logs.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Process-PSModule v6 enforces PublicHelpLink: the first .LINK in every public command must be its canonical psmodule.io documentation URL. Both commands had no .LINK at all, so Test-SourceCode failed on all three runners. The examples also referenced New-SemVer and ConvertTo-SemVer, which are not commands this module exports.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title ⚙️ [Maintenance]: Align PSSemVer with the PSModule repository standard and refresh the pipeline 🪲 [Fix]: Correct the public command help and bring PSSemVer onto the current pipeline Aug 2, 2026
@MariusStorhaug Marius Storhaug (MariusStorhaug) added Patch Fixes bugs or adds small fixes to existing functionality and removed NoRelease Do not create a release labels Aug 2, 2026
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 2, 2026 16:42
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 1a621b1 into main Aug 2, 2026
65 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the align-with-psmodule-standards branch August 2, 2026 16:49
@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

✅ New release: PowerShell Gallery - PSSemVer 1.1.10

@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

✅ New release: GitHub - PSSemVer 1.1.10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Patch Fixes bugs or adds small fixes to existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant